<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io.comparator;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Comparator;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.commons.io.IOCase;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Compare the &lt;b&gt;names&lt;/b&gt; of two files for order (see {@link File#getName()}).<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> * This comparator can be used to sort lists or arrays of files<a name="line.28"></a>
<span class="sourceLineNo">029</span> * by their name either in a case-sensitive, case-insensitive or<a name="line.29"></a>
<span class="sourceLineNo">030</span> * system dependent case sensitive way. A number of singleton instances<a name="line.30"></a>
<span class="sourceLineNo">031</span> * are provided for the various case sensitivity options (using {@link IOCase})<a name="line.31"></a>
<span class="sourceLineNo">032</span> * and the reverse of those options.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Example of a &lt;i&gt;case-sensitive&lt;/i&gt; file name sort using the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link #NAME_COMPARATOR} singleton instance:<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;pre&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *       List&amp;lt;File&amp;gt; list = ...<a name="line.37"></a>
<span class="sourceLineNo">038</span> *       ((AbstractFileComparator) NameFileComparator.NAME_COMPARATOR).sort(list);<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;/pre&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Example of a &lt;i&gt;reverse case-insensitive&lt;/i&gt; file name sort using the<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@link #NAME_INSENSITIVE_REVERSE} singleton instance:<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;pre&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *       File[] array = ...<a name="line.44"></a>
<span class="sourceLineNo">045</span> *       ((AbstractFileComparator) NameFileComparator.NAME_INSENSITIVE_REVERSE).sort(array);<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/pre&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @since 1.4<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>public class NameFileComparator extends AbstractFileComparator implements Serializable {<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>    private static final long serialVersionUID = 8397947749814525798L;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /** Case-sensitive name comparator instance (see {@link IOCase#SENSITIVE}) */<a name="line.55"></a>
<span class="sourceLineNo">056</span>    public static final Comparator&lt;File&gt; NAME_COMPARATOR = new NameFileComparator();<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /** Reverse case-sensitive name comparator instance (see {@link IOCase#SENSITIVE}) */<a name="line.58"></a>
<span class="sourceLineNo">059</span>    public static final Comparator&lt;File&gt; NAME_REVERSE = new ReverseFileComparator(NAME_COMPARATOR);<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /** Case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE}) */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    public static final Comparator&lt;File&gt; NAME_INSENSITIVE_COMPARATOR = new NameFileComparator(IOCase.INSENSITIVE);<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>    /** Reverse case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE}) */<a name="line.64"></a>
<span class="sourceLineNo">065</span>    public static final Comparator&lt;File&gt; NAME_INSENSITIVE_REVERSE = new ReverseFileComparator(NAME_INSENSITIVE_COMPARATOR);<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /** System sensitive name comparator instance (see {@link IOCase#SYSTEM}) */<a name="line.67"></a>
<span class="sourceLineNo">068</span>    public static final Comparator&lt;File&gt; NAME_SYSTEM_COMPARATOR = new NameFileComparator(IOCase.SYSTEM);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /** Reverse system sensitive name comparator instance (see {@link IOCase#SYSTEM}) */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public static final Comparator&lt;File&gt; NAME_SYSTEM_REVERSE = new ReverseFileComparator(NAME_SYSTEM_COMPARATOR);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /** Whether the comparison is case sensitive. */<a name="line.73"></a>
<span class="sourceLineNo">074</span>    private final IOCase caseSensitivity;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>    /**<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * Construct a case sensitive file name comparator instance.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
<span class="sourceLineNo">079</span>    public NameFileComparator() {<a name="line.79"></a>
<span class="sourceLineNo">080</span>        this.caseSensitivity = IOCase.SENSITIVE;<a name="line.80"></a>
<span class="sourceLineNo">081</span>    }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    /**<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * Construct a file name comparator instance with the specified case-sensitivity.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive<a name="line.86"></a>
<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    public NameFileComparator(final IOCase caseSensitivity) {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        this.caseSensitivity = caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Compare the names of two files with the specified case sensitivity.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @param file1 The first file to compare<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param file2 The second file to compare<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @return a negative value if the first file's name<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * is less than the second, zero if the names are the<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * same and a positive value if the first files name<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * is greater than the second file.<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span>    public int compare(final File file1, final File file2) {<a name="line.103"></a>
<span class="sourceLineNo">104</span>        return caseSensitivity.checkCompareTo(file1.getName(), file2.getName());<a name="line.104"></a>
<span class="sourceLineNo">105</span>    }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>    /**<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * String representation of this file comparator.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     *<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @return String representation of this file comparator<a name="line.110"></a>
<span class="sourceLineNo">111</span>     */<a name="line.111"></a>
<span class="sourceLineNo">112</span>    @Override<a name="line.112"></a>
<span class="sourceLineNo">113</span>    public String toString() {<a name="line.113"></a>
<span class="sourceLineNo">114</span>        return super.toString() + "[caseSensitivity=" + caseSensitivity + "]";<a name="line.114"></a>
<span class="sourceLineNo">115</span>    }<a name="line.115"></a>
<span class="sourceLineNo">116</span>}<a name="line.116"></a>




























































</pre>
</div>
</body>
</html>
